Appointment Management API - TMF646
API Data Dictionary - Provision - POST appointment
API Request Payload
| HTTP Header Name | Example Field Value | Description |
|---|---|---|
| Correlation-ID | c97ded75-44fa-4b69-9f3b-01d513a41efe | A GUID to relate requests belonging to the same transaction |
| Payload Field Name | Example Field Value | Description |
|---|---|---|
| appointmentType | Standard Flexible |
Extension to the API. It defines the Type of Appointment the Partner is requesting from those offered by the suppliers. |
| category | Provision | Extension to the API. It defines the Type of the Appointment whether Repair, Order provisioning or Order Modification. |
| installationType | No site visit Standard Premium Advanced |
Extension to the API. |
| telecare | boolean | Extension to the API. Boolean. Whether this is a vulnerable customer. |
| isUPS | boolean | Extension to the API. Boolean. Whether providing UPS installation is required. |
| productName | C-BIP-FTTP C-BIP-FTTC C-BIP-ADSL |
Extension to the API. A product name that is sent by Partners to Mulesoft. |
| provisioningCommand | Provision Select, etc. | Extension to the API. A provisioning command sent by Partners to Mulesoft. |
| technology | WBB + fiber | Extension to the API. Sent by Partners to Mulesoft. |
| requestedTimeslot | See requestedTimeslot table | array |
| validFor\startDateTime | 2025-02-15T08:00:00.000Z | Timestamp of the start time of the time period for the appointment to start. |
| validFor\endDateTime | 2025-02-18T08:00:00.000Z | Timestamp of the end time of the time period for the appointment to start. |
| productId | C-BIP-FTTP | Extension to the API. Supplied by Mulesoft on the internal interface for Amex. |
| serviceId | Extension (displayed when provisioning command) | Extension to the API. Supplied by Mulesoft on the internal interface for Amex. |
| appointmentExecutionStatus | Exists (depending on provisioning command) | Extension to the API. Supplied by Mulesoft on the internal interface for Amex. |
| relatedEntity | See relatedEntity table | array contains the BillingAccount element |
| interactionPlace | See interactionPlace table | array |
| @type | PXCAppointment | |
| @baseType | Appointment |
API Response Payload
| HTTP Header Name | Example Field Value | Description |
|---|---|---|
| Correlation-ID | c97ded75-44fa-4b69-9f3b-01d513a41efe | A GUID to relate requests belonging to the same transaction |
| Payload Field Name | Example Field Value | Description |
|---|---|---|
| id | APP1234 | Unique identifier of the appointment. A PXC reference. |
| href | /appointment/{id} | The URI of the resource. |
| category | Provision | It defines the Type of the Appointment whether for Repair, Order provisioning or Order Modification. |
| appointmentType | Standard Flexible |
Extension to the API. It defines the Type of Appointment the Partner is requesting from those offered by the suppliers. |
| supplierAppointmentId | 83234 | Extension to the API. Unique identifier for the appointment. A supplier reference when Openreach creates an Aline appointment. |
| openreachAppointmentId | 1234 | Extension to the API. Unique identifier for the appointment internally in Openreach Strategic Interface. A Fiber Cable reference. |
| installationType | No site visit Standard Premium Advanced |
Extension to the API. |
| telecare | boolean | Extension to the API. Boolean. Whether this is a vulnerable customer. |
| isUPS | boolean | Extension to the API. Boolean. Whether providing UPS installation is required. |
| productName | C-BIP-FTTP C-BIP-FTTC C-BIP-ADSL |
Extension to the API. A product name sent by Partners to Mulesoft. |
| provisioningCommand | Provision Select, etc. | Extension to the API. A provisioning command sent by Partners to Mulesoft. |
| technology | WBB + fiber | Extension to the API. Sent by Partners to Mulesoft. |
| description | Fix an internet connection problem for a customer | Extension to the API. Description used by partners. |
| creationDate | 2025-02-01T14:48:45.071Z | Timestamp of the Appointment creation date. |
| lastUpdate | 2025-02-01T14:48:45.071Z | Timestamp of the last time Appointment was updated. |
| requestedExecutionDate | 2025-02-01T14:48:45.071Z | Extension to the API. Timestamp until which appointment transaction is valid and can be used with an order. Same as the reservation date for Openreach appointments. |
| validFor\startDateTime | 2025-02-15T08:00:00.000Z | Timestamp of the start time of the appointment. (UTC timestamp) |
| validFor\endDateTime | 2025-02-18T08:00:00.000Z | Timestamp of the end time of the appointment. |
| relatedEntity | See relatedEntity table |
array for AccessCASR contains a AccessCASR and the BillingAccount elements id = <an AccessCASR> role = relatedService @referredType = Service for ProductId contains a ProductId and the BillingAccount elements id = <a ProductId> role = relatedProduct @referredType = Product |
| note | See note table | array |
| @type | PXCAppointment | |
| @baseType | Appointment |